/*
 *  linux/tools/build.c
 *
 *  (C) 1991  Linus Torvalds
 */

/*
 * This file builds a disk-image from three different files:
 *
 * - bootsect: max 510 bytes of 8086 machine code, loads the rest
 * - setup: max 4 sectors of 8086 machine code, sets up system parm
 * - system: 80386 code for actual system
 *
 * It does some checking that all files are of the correct type, and
 * just writes the result to stdout, removing headers and padding to
 * the right amount. It also writes some system data to stderr.
 * 
 * 主要的功能：解析bootsect(510字节)、setup(最多4扇区)、system文件，从中提取出二进制代码，依次写入
 * 磁盘映像Image中。写入扇区号依次为0、1、5，同时将根文件系统设备号写入508、509字节处
 */

/*
 * Changes by tytso to allow root device specification
 */
#include <stdio.h>	/* fprintf */
#include <string.h>
#include <stdlib.h>	/* contains exit */
#include <sys/types.h>	/* unistd.h needs this */
#include <sys/stat.h>
#include <unistd.h>	/* contains read/write */
#include <fcntl.h>

#define MAJOR(a) (((unsigned)(a))>>8)
#define MINOR(a) ((a)&0xff)

// 以下未用到
#define MINIX_HEADER 32			
#define GCC_HEADER 1024

#define SYS_SIZE 0x3000			// system模块的最大大小，单位是16字节

// 缺省的主设备号和次设备号
// 注意，这个非常重要，不然没有办法正常启动
#define DEFAULT_MAJOR_ROOT 3
#define DEFAULT_MINOR_ROOT 0x1

/* max nr of sectors of setup: don't change unless you also change
 * bootsect etc */
#define SETUP_SECTS 4

#define STRINGIFY(x) #x

// 死机函数
void die(char * str)
{
	// 打印错误信息，然后退出程序
	fprintf(stderr,"%s\n",str);
	exit(1);
}

// 提示使用方法并退出
void usage(void)
{
	die("Usage: build bootsect setup system [rootdev] [> image]");
}

#ifndef O_BINARY
#define O_BINARY		0
#endif 
int main(int argc, char ** argv)
{
	int i,c,id;
	char buf[1024];
	char major_root, minor_root;
	struct stat sb;

	// 调用：tools/build boot/bootsect boot/setup tools/kernel $(ROOT_DEV) > Image
	if ((argc != 4) && (argc != 5))
		// 至少4个参数或5个，即要求bootsect, setup, kernel都得有
		usage();
	if (argc == 5) {
		// 5个参数，即包含RTOO_DEV
		if (strcmp(argv[4], "FLOPPY")) {
			// 非软盘，使用stat取设备号信息
			if (stat(argv[4], &sb)) {
				perror(argv[4]);
				die("Couldn't stat root device.");
			}

			// 取得的设备文件/dev/xxxx的设备号
			major_root = MAJOR(sb.st_rdev);
			minor_root = MINOR(sb.st_rdev);
		} else {
			// 软盘，取0，即使用当前的计算机时启动的设备作为根设备?
			major_root = 0;
			minor_root = 0;
		}
	} else {
		// 没有包含ROOT_DEV，则使用默认设备号。todo: 缺省的是/dev/hd6 
		major_root = DEFAULT_MAJOR_ROOT;
		minor_root = DEFAULT_MINOR_ROOT;
	}
	// 显示设备号信息
	fprintf(stderr, "Root device is (%d, %d)\n", major_root, minor_root);
	if ((major_root != 2) && (major_root != 3) && (major_root != 0)) {
		// 只是能软盘2、硬盘3或者启动设备0作为主设备号？
		fprintf(stderr, "Illegal root device (major = %d)\n",
			major_root);
		die("Bad root device --- major #");
	}
	
	// 清空缓存
	for (i=0;i<sizeof buf; i++) buf[i]=0;
	
	// 自己加的，用于打开Image
	FILE * image_id;
	if ((image_id =fopen("Image", "wb")) < 0) {
		die("create image failed");
	}
 
	// -------------------- 从bootsect中提取代码写入到Image文件中 ---------------
	// 打开bootsect，其格式为minix格式
	if ((id=open(argv[1],O_RDONLY | O_BINARY))<0)
		die("Unable to open 'boot'");
	#if 0		// 我更换成了gcc工具链编译，生成的是二进制文件，没有Minix文件头
	// 读取文件头，32字节
	if (read(id,buf,MINIX_HEADER) != MINIX_HEADER)
		die("Unable to read header of 'boot'");
	// 检查minix文件头的魔数(0x0301), a_flags(0x10可执行文件)和a_cpu（0x4, i8086），必须要这个值0x04100301
	if (((uint32_t *) buf)[0]!=0x04100301) {
		fprintf(stderr, "%lx, %d\n", ((uint32_t *) buf)[0], sizeof(uint32_t));
		die("Non-Minix header of 'boot'");
	}
	// 检查hdrlen即minix头部长度，须为32. 后面3字节没有用到，默认为0，所以这里一直取了
	if (((uint32_t *) buf)[1]!=MINIX_HEADER) {
		die("Non-Minix header of 'boot'");
	}
	// 检查a_data, 不能为0
	if (((uint32_t *) buf)[3]!=0)
		die("Illegal data segment in 'boot'");

	// 检查a_bss不能为0
	if (((uint32_t *) buf)[4]!=0)
		die("Illegal bss in 'boot'");
	// 检查入口地址a_entry不能为0
	if (((uint32_t *) buf)[5] != 0) {
		die("Non-Minix header of 'boot'");
	}
	// 检查a_syms符号表大小不能为0
	if (((uint32_t *) buf)[7] != 0)
		die("Illegal symbol table in 'boot'");
	#endif
	// 文件头之后就是boot的数据，可使用二进制文件查看，共512字节
	i=read(id,buf,sizeof buf);
	fprintf(stderr,"Boot sector %d bytes.\n",i);
	if (i != 512)
		// 如果读取的不是512字节，说明有错误，死机
		die("Boot block must be exactly 512 bytes");
	if ((*(unsigned short *)(buf+510)) != 0xAA55)
		// 最后两字节的引导标志应当为0xaa, 0x55
		die("Boot block hasn't got boot flag (0xAA55)");
	// 508和509保存了根文件系统所在的设备号
	buf[508] = (char) minor_root;
	buf[509] = (char) major_root;	
	// 写到标准输出。由于命令行使用了  > Image，所以实际是写入到了Image文件
	//i=write(1,buf,512);
	i=fwrite(buf,1,512, image_id);
	if (i!=512)
		die("Write call failed");
	// 关闭bootsect对应的文件
	close (id);

	// -------------------- 从setup中提取代码写入到Image文件中 ---------------
	// 打开setup其格式为minix格式
	if ((id=open(argv[2],O_RDONLY | O_BINARY,0))<0)
		die("Unable to open 'setup'");
	#if 0 		// 我更换成了gcc工具链编译，生成的是二进制文件，没有Minix文件头
	// 读取文件头，32字节
	if (read(id,buf,MINIX_HEADER) != MINIX_HEADER)
		die("Unable to read header of 'setup'");
	// 检查minix文件头的魔数(0x0301), a_flags(0x10可执行文件)和a_cpu（0x4, i8086），必须要这个值0x04100301
	if (((uint32_t *) buf)[0]!=0x04100301)
		die("Non-Minix header of 'setup'");
	// 检查hdrlen即minix头部长度，须为32. 后面3字节没有用到，默认为0，所以这里一直取了
	if (((uint32_t *) buf)[1]!=MINIX_HEADER)
		die("Non-Minix header of 'setup'");
	// 检查a_data, 不能为0
	if (((uint32_t *) buf)[3]!=0)
		die("Illegal data segment in 'setup'");
	// 检查a_bss不能为0
	if (((uint32_t *) buf)[4]!=0)
		die("Illegal bss in 'setup'");
	// 检查入口地址a_entry不能为0
	if (((uint32_t *) buf)[5] != 0)
		die("Non-Minix header of 'setup'");
	// 检查a_syms符号表大小不能为0
	if (((uint32_t *) buf)[7] != 0)
		die("Illegal symbol table in 'setup'");
	#endif
	// 文件头之后就是setup，可使用二进制文件查看
	for (i=0 ; (c=read(id,buf,sizeof buf))>0 ; i+=c )
		// 写到标准输出。由于命令行使用了  > Image，所以实际是写入到了Image文件
		//if (write(1,buf,c)!=c)
		if (fwrite(buf,1,c,image_id)!=c)
			die("Write call failed");
	close (id);

	// setup最多4个扇区代码，这里检查不能超过，超过就出错
	if (i > SETUP_SECTS*512)
		die("Setup exceeds " STRINGIFY(SETUP_SECTS)
			" sectors - rewrite build/boot/setup");

	// buf清0
	fprintf(stderr,"Setup is %d bytes.\n",i);
	for (c=0 ; c<sizeof(buf) ; c++)
		buf[c] = '\0';
	// 如果setup没有4个扇区的代码，则继续填充至4KB大小
	while (i<SETUP_SECTS*512) {
		c = SETUP_SECTS*512-i;
		if (c > sizeof(buf))
			c = sizeof(buf);
		//if (write(1,buf,c) != c)
		if (fwrite(buf,1,c,image_id) != c)
			die("Write call failed");
		i += c;
	}

	// -------------------- 从system中提取代码写入到Image文件中 ---------------
	if ((id=open(argv[3],O_RDONLY | O_BINARY,0))<0)
		die("Unable to open 'system'");

	// todo: 这里的system模块文件格式bootsect类似，都有个头
	// 所以这里将头给读了出来。然后写入到磁盘中。实际写入的二进制内核映像
//	if (read(id,buf,GCC_HEADER) != GCC_HEADER)
//		die("Unable to read header of 'system'");
//	if (((long *) buf)[5] != 0)
//		die("Non-GCC header of 'system'");
	// 读取system模块，写标准输出。由于命令行使用了  > Image，所以实际是写入到了Image文件
	for (i=0 ; (c=read(id,buf,sizeof buf))>0 ; i+=c )
		//if (write(1,buf,c)!=c)
		if (fwrite(buf,1,c,image_id)!=c)
			die("Write call failed");
	close(id);
	fprintf(stderr,"System is %d bytes.\n",i);

	// 不得超过SYS_SIZE*16大小。超过就失败了 196kB，在bootsect中有检查
	if (i > SYS_SIZE*16)
		die("System is too big");
	return(0);
}
